﻿// ------------------------------------------------------------------------
// 版权信息
// 版权归重庆虫儿飞科技有限公司所有。
// 所有权利保留。
// 官方网站：https://netokit.com
// 许可证信息
// Neto.Kit 项目主要遵循 MIT 许可证和 Apache 许可证（版本 2.0）进行分发和使用。
// 许可证的完整文本可以在源代码树根目录中的 LICENSE-APACHE 和 LICENSE-MIT 文件中找到。
// 
// 使用条款
// 使用本代码应遵守相关法律法规和许可证的要求。
// 
// 免责声明
// 对于因使用本代码而产生的任何直接、间接、偶然、特殊或后果性损害，我们不承担任何责任。
// 
// 其他重要信息
// Neto.Kit 项目的版权、商标、专利和其他相关权利均受相应法律法规的保护。
// 有关 Neto.Kit 项目的其他详细信息，请参阅位于源代码树根目录中的 COPYRIGHT 和 DISCLAIMER 文件。
// 
// 更多信息
// 请访问 https://netokit.com 获取更多关于 Neto.Kit 项目的许可证和版权信息。
// ------------------------------------------------------------------------

namespace Neto.Core.Entities;

/// <summary>
///     短信发送记录
/// </summary>
[SugarTable("Sys_SmsSendRecord", TableDescription = "短信发送记录")]
public class SysSmsSendRecord : SsFullEntityNoIdentity, IExtensionData
{
    /// <summary>
    ///     内容
    /// </summary>
    [SugarColumn(ColumnDescription = "内容", Length = 500)]
    public string Content { get; set; }

    /// <summary>
    ///     发送参数
    ///     例如：{"code":"123456"}
    /// </summary>
    [SugarColumn(ColumnDescription = "发送参数")]
    public string Param { get; set; }

    /// <summary>
    ///     接收号码
    /// </summary>
    [SugarColumn(ColumnDescription = "接收号码", Length = 50)]
    public string Receive { get; set; }

    /// <summary>
    ///     发送状态(待发送 = 0,发送成功 = 1,发送失败 = 2)
    /// </summary>
    [SugarColumn(ColumnDescription = "发送状态")]
    public SmsSendState State { get; set; }

    /// <summary>
    ///     发送次数
    /// </summary>
    [SugarColumn(ColumnDescription = "发送次数", DefaultValue = "0")]
    public int SendNum { get; set; }

    /// <summary>
    ///     最大发送次数
    /// </summary>
    [SugarColumn(ColumnDescription = "最大发送次数", DefaultValue = "0")]
    public int SendMaxNum { get; set; }

    /// <summary>
    ///     Json数据
    /// </summary>
    [SugarColumn(ColumnDescription = "扩展字段", ColumnDataType = StaticConfig.CodeFirst_BigString, IsJson = true,
        IsNullable = true)]
    public Dictionary<string, object>? ExtensionData { get; set; }

    #region 验证码

    /// <summary>
    ///     验证码
    /// </summary>
    [SugarColumn(ColumnDescription = "验证码")]
    public string VerCode { get; set; }

    /// <summary>
    ///     使用过期时间
    /// </summary>
    [SugarColumn(ColumnDescription = "使用过期时间")]
    public DateTimeOffset? UseExpireTime { get; set; }

    /// <summary>
    ///     是否使用
    /// </summary>
    [SugarColumn(ColumnDescription = "是否使用")]
    public bool IsUse { get; set; }

    /// <summary>
    ///     使用时间
    /// </summary>
    [SugarColumn(ColumnDescription = "使用时间")]
    public DateTimeOffset? UseTime { get; set; }

    #endregion 验证码

    #region 发送结果

    /// <summary>
    ///     发送结果的消息
    /// </summary>
    [SugarColumn(ColumnDescription = "发送结果的消息")]
    public string SendResultMessage { get; set; }

    /// <summary>
    ///     发送结果的状态码
    /// </summary>
    [SugarColumn(ColumnDescription = "发送结果的状态码")]
    public string SendResultCode { get; set; }

    /// <summary>
    ///     发送结果的唯一id
    /// </summary>
    [SugarColumn(ColumnDescription = "发送结果的唯一id")]
    public string SendResultSmsId { get; set; }

    /// <summary>
    ///     返回数据的json数据
    /// </summary>
    [SugarColumn(ColumnDescription = "返回数据的json数据")]
    public string SendResultData { get; set; }

    #endregion 发送结果

    #region ref

    /// <summary>
    ///     数据Id(发送短信关联的表ID)
    /// </summary>
    [SugarColumn(ColumnDescription = "数据Id")]
    public long? DataId { get; set; }

    /// <summary>
    ///     短信模板ID
    /// </summary>
    [SugarColumn(ColumnDescription = "短信模板ID")]
    public long SmsTemplateId { get; set; }

    /// <summary>
    ///     短信模板
    /// </summary>
    [Navigate(NavigateType.OneToOne, nameof(SmsTemplateId))]
    public SysSmsTemplate SmsTemplate { get; set; }

    #endregion ref
}

/// <summary>
///     短信发送记录状态
/// </summary>
public enum SmsSendState
{
    待发送 = 0,
    发送成功 = 1,
    发送失败 = 2
}